/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Esta anotação é utilizada para definar o campo de uma entidade como um
 * filtro de uma pesquisa.<br>
 * Os Valores definidos nesta anotação são utilzados na construção do filtro.
 * 
 * @author Glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FilterCriteria {

    /**
     * Contém as varias definições para um filtro.
     * @return Retorna as definições do filtro.
     */
    public CriteriaDefinition[] definitions() default {};

    /**
     * Contém as varias definições para filtro em entidades associadas.
     * @return Retorna a definição dos filtros em entidade associada.
     */
    public CriteriaEmbedded[] embedded() default {};

    /**
     * Contém as varias definições para seleção de entidades associadas que
     * serão utilizadas como filtro.
     * @return Retorna as definições para seleção de uma entidade associada.
     */
    public CriteriaSelection[] selection() default {};
}
